<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>hwicap: XHwIcap Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">hwicap
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XHwIcap Struct Reference<div class="ingroups"><a class="el" href="group__hwicap__v10__0.html">Hwicap_v10_0</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aab0ffe813aa173907a53fbdfe62de599"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_hw_icap___config.html">XHwIcap_Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_hw_icap.html#aab0ffe813aa173907a53fbdfe62de599">HwIcapConfig</a></td></tr>
<tr class="separator:aab0ffe813aa173907a53fbdfe62de599"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b08114ef8b6d6478e9ae4890e68f671"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_hw_icap.html#a6b08114ef8b6d6478e9ae4890e68f671">StatusRef</a></td></tr>
<tr class="separator:a6b08114ef8b6d6478e9ae4890e68f671"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The user is required to allocate a variable of this type for every HwIcap device in the system. A pointer to a variable of this type is then passed to the driver API functions. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="abd5f77c5e222b3372623794a6d8bb05c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XHwIcap::BytesPerFrame</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of Bytes per minor Frame. </p>

<p>Referenced by <a class="el" href="group__hwicap__v10__0.html#ga928bb0618a3f4bab3264eceb7b898d6d">XHwIcap_CfgInitialize()</a>.</p>

</div>
</div>
<a class="anchor" id="a1e2e190f1bd74c7aa6fbe31288ee6619"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XHwIcap::DeviceIdCode</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>IDCODE of targeted device. </p>

<p>Referenced by <a class="el" href="group__hwicap__v10__0.html#ga7b2b996ebb5c5268a07d39e9add552dc">XHwIcap_DeviceWriteFrame()</a>.</p>

</div>
</div>
<a class="anchor" id="aab0ffe813aa173907a53fbdfe62de599"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_hw_icap___config.html">XHwIcap_Config</a> XHwIcap::HwIcapConfig</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Instance of the config struct. </p>

<p>Referenced by <a class="el" href="group__hwicap__v10__0.html#ga2493ca18331cba6eb2162449b7dab66e">XHwIcap_Abort()</a>, <a class="el" href="group__hwicap__v10__0.html#ga928bb0618a3f4bab3264eceb7b898d6d">XHwIcap_CfgInitialize()</a>, <a class="el" href="group__hwicap__v10__0.html#ga27e9ac291323ef043303367460b70de0">XHwIcap_DeviceRead()</a>, <a class="el" href="group__hwicap__v10__0.html#gaab446328af0c5b397eeaee15088bf8e8">XHwIcap_DeviceWrite()</a>, <a class="el" href="group__hwicap__v10__0.html#ga92dbad9de7f4a4e41fcde30fc2ebda1c">XHwIcap_FlushFifo()</a>, <a class="el" href="group__hwicap__v10__0.html#ga305707eb013da39d038183c7f0d8fed9">XHwIcap_GetConfigReg()</a>, <a class="el" href="group__hwicap__v10__0.html#ga6c516a5e0cb9f928e591a152cd567dca">XHwIcap_Reset()</a>, and <a class="el" href="group__hwicap__v10__0.html#ga0716d6a3c65aabb73344bee9c4c9cfc7">XHwIcap_SelfTest()</a>.</p>

</div>
</div>
<a class="anchor" id="a1034ea22a5d2bb5a3eab6e5abe6a6423"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XHwIcap::IsPolled</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device is in polled mode. </p>

<p>Referenced by <a class="el" href="group__hwicap__v10__0.html#ga928bb0618a3f4bab3264eceb7b898d6d">XHwIcap_CfgInitialize()</a>, and <a class="el" href="group__hwicap__v10__0.html#gaab446328af0c5b397eeaee15088bf8e8">XHwIcap_DeviceWrite()</a>.</p>

</div>
</div>
<a class="anchor" id="a7e038eb9c938aaedaf156b772fc4de0c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XHwIcap::IsReady</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device is initialized and ready. </p>

<p>Referenced by <a class="el" href="group__hwicap__v10__0.html#ga2493ca18331cba6eb2162449b7dab66e">XHwIcap_Abort()</a>, <a class="el" href="group__hwicap__v10__0.html#ga928bb0618a3f4bab3264eceb7b898d6d">XHwIcap_CfgInitialize()</a>, <a class="el" href="group__hwicap__v10__0.html#gaff2a2db509296264ad44270798b4bed2">XHwIcap_CommandCapture()</a>, <a class="el" href="group__hwicap__v10__0.html#ga7c4b2410acc62af539dac03005668754">XHwIcap_CommandDesync()</a>, <a class="el" href="group__hwicap__v10__0.html#ga27e9ac291323ef043303367460b70de0">XHwIcap_DeviceRead()</a>, <a class="el" href="group__hwicap__v10__0.html#gafdb7b9947a1e1610a214814c1b19a0a1">XHwIcap_DeviceReadFrame()</a>, <a class="el" href="group__hwicap__v10__0.html#gaab446328af0c5b397eeaee15088bf8e8">XHwIcap_DeviceWrite()</a>, <a class="el" href="group__hwicap__v10__0.html#ga7b2b996ebb5c5268a07d39e9add552dc">XHwIcap_DeviceWriteFrame()</a>, <a class="el" href="group__hwicap__v10__0.html#ga92dbad9de7f4a4e41fcde30fc2ebda1c">XHwIcap_FlushFifo()</a>, <a class="el" href="group__hwicap__v10__0.html#ga305707eb013da39d038183c7f0d8fed9">XHwIcap_GetConfigReg()</a>, <a class="el" href="group__hwicap__v10__0.html#ga6c516a5e0cb9f928e591a152cd567dca">XHwIcap_Reset()</a>, <a class="el" href="group__hwicap__v10__0.html#ga0716d6a3c65aabb73344bee9c4c9cfc7">XHwIcap_SelfTest()</a>, and <a class="el" href="group__hwicap__v10__0.html#gaa2f2f23cf842c10f443509f8861a194a">XHwIcap_SetInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a6f6de856eedef3b63c0df360781984d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XHwIcap::IsTransferInProgress</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A transfer is in progress. </p>

<p>Referenced by <a class="el" href="group__hwicap__v10__0.html#ga928bb0618a3f4bab3264eceb7b898d6d">XHwIcap_CfgInitialize()</a>, <a class="el" href="group__hwicap__v10__0.html#ga27e9ac291323ef043303367460b70de0">XHwIcap_DeviceRead()</a>, <a class="el" href="group__hwicap__v10__0.html#gaab446328af0c5b397eeaee15088bf8e8">XHwIcap_DeviceWrite()</a>, and <a class="el" href="group__hwicap__v10__0.html#ga9cf1ff1dd1056a11f65a903c47492842">XHwIcap_IntrHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a6d23e949e46c1a0d88dd6ea065dc70c0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XHwIcap::RemainingWords</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of Words left to transfer. </p>

<p>Referenced by <a class="el" href="group__hwicap__v10__0.html#ga27e9ac291323ef043303367460b70de0">XHwIcap_DeviceRead()</a>, <a class="el" href="group__hwicap__v10__0.html#gaab446328af0c5b397eeaee15088bf8e8">XHwIcap_DeviceWrite()</a>, and <a class="el" href="group__hwicap__v10__0.html#ga9cf1ff1dd1056a11f65a903c47492842">XHwIcap_IntrHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a694bf48b4c008d20e058cb5f610f35f5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XHwIcap::RequestedWords</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of Words to transfer. </p>

<p>Referenced by <a class="el" href="group__hwicap__v10__0.html#ga27e9ac291323ef043303367460b70de0">XHwIcap_DeviceRead()</a>, <a class="el" href="group__hwicap__v10__0.html#gaab446328af0c5b397eeaee15088bf8e8">XHwIcap_DeviceWrite()</a>, and <a class="el" href="group__hwicap__v10__0.html#ga9cf1ff1dd1056a11f65a903c47492842">XHwIcap_IntrHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="aab5f5571907cba99091ede9d3cadd039"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__hwicap__v10__0.html#ga5f15f93ec50b3415103774dec986d387">XHwIcap_StatusHandler</a> XHwIcap::StatusHandler</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Interrupt handler callback. </p>

<p>Referenced by <a class="el" href="group__hwicap__v10__0.html#ga928bb0618a3f4bab3264eceb7b898d6d">XHwIcap_CfgInitialize()</a>, <a class="el" href="group__hwicap__v10__0.html#ga9cf1ff1dd1056a11f65a903c47492842">XHwIcap_IntrHandler()</a>, and <a class="el" href="group__hwicap__v10__0.html#gaa2f2f23cf842c10f443509f8861a194a">XHwIcap_SetInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a6b08114ef8b6d6478e9ae4890e68f671"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XHwIcap::StatusRef</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback ref. </p>
<p>for the interrupt handler </p>

<p>Referenced by <a class="el" href="group__hwicap__v10__0.html#ga9cf1ff1dd1056a11f65a903c47492842">XHwIcap_IntrHandler()</a>, and <a class="el" href="group__hwicap__v10__0.html#gaa2f2f23cf842c10f443509f8861a194a">XHwIcap_SetInterruptHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a3f9285b94c87fa0052336a7fdeb75bf4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XHwIcap::WordsPerFrame</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of Words per minor Frame. </p>

<p>Referenced by <a class="el" href="group__hwicap__v10__0.html#ga928bb0618a3f4bab3264eceb7b898d6d">XHwIcap_CfgInitialize()</a>, <a class="el" href="group__hwicap__v10__0.html#gafdb7b9947a1e1610a214814c1b19a0a1">XHwIcap_DeviceReadFrame()</a>, and <a class="el" href="group__hwicap__v10__0.html#ga7b2b996ebb5c5268a07d39e9add552dc">XHwIcap_DeviceWriteFrame()</a>.</p>

</div>
</div>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
